版本：V4.0

Akuvox服务API

获取Akuvox设备列表

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
ciphertext	String	Body	密文，依赖SDK解析
relays	[]Object<relay>	Body	门控信息
security_relays	[]Object<relay>	Body	安全门控信息
is_public	Boolean	Body	判断是否为公共设备 true：是 false：否
device_name	String	Body	设备名称
sip	String	Body	SIP号
device_type	String	Body	判断设备类型 Multi-tenants Doorphone：梯口机 Single-tenant Doorphone：门口机 Indoor Monitor：室内机 Guard Phone：管理机 Access Control：门禁
mac	String	Body	MAC地址
online	Boolean	Body	判断设备在离线状态 true：在线 false：离线
rtsp_url	String	Body	RTSP地址

relay说明

参数名	类型	位置	说明
relay_name	String	Body	门控名称
relay_number	String	Body	门控拨号键值
relay_id	String	Body	门控ID

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_device_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "ciphertext": "7b3d75f5a8cfa959167852468fca08a3",
      "security_relays": [],
      "relays": [
        {
          "relay_name": "Front Door 3",
          "relay_number": "#",
          "relay_id": "r4b5a73f8dd84abaa94dcs248be49b0d2"
        }
      ],
      "is_public": true,
      "device_name": "Front Door",
      "sip": "123132312",
      "device_type": "Multi-tenants Doorphone",
      "mac": "0C110532D226",
      "online": true,
      "rtsp": "rtsp://user:bfk69623v6Lxxxxxc@12.136.56.119:554/211F03FF0008"
    }
  ]
}

失败返回示例

见接口失败返回

获取Akuvox私钥开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
private_key	String	Body	私钥

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_open_door_private_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "private_key": "12345"
  }
}

失败返回示例

见接口失败返回

更新Akuvox私钥开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
private_key	String	Body	是	私钥
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_akuvox_open_door_private_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "private_key": "12345",
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取Akuvox NFC开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
nfc_code	String	Body	NFC码
enable_nfc	Boolean	Body	判断是否启用NFC true：启用 false：禁用

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_open_door_nfc_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "nfc_code": "F0A5B8FDC7643920",
    "enable_nfc": true
  }
}

失败返回示例

见接口失败返回

更新Akuvox NFC开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
enable_nfc	Boolean	Body	是	判断是否启用NFC true：启用 false：禁用
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
nfc_code	String	Body	NFC码

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_akuvox_open_door_nfc_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "enable_nfc": true,
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "nfc_code": "F0A5B8FDC7643920"
  }
}

失败返回示例

见接口失败返回

获取Akuvox蓝牙开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
ble_code	String	Body	蓝牙码
enable_ble	Boolean	Body	判断是否启用蓝牙 true：启用 false：禁用

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_open_door_ble_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ble_code": "F0A5B8FDC7643920",
    "enable_ble": true
  }
}

失败返回示例

见接口失败返回

更新Akuvox蓝牙开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
enable_ble	Boolean	Body	是	判断是否启用蓝牙 true：启用 false：禁用
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
ble_code	String	Body	蓝牙码

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_akuvox_open_door_ble_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "enable_ble": true,
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ble_code": "F0A5B8FDC7643920"
  }
}

失败返回示例

见接口失败返回

获取Akuvox临时密码开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
temp_key	String	Body	临时密码
start_time	String	Body	开始时间，UTC
finish_time	String	Body	结束时间，UTC
count	Integer	Body	使用次数
qr_code_url	String	Body	二维码地址

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_open_door_temp_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "start_time": "2020-03-12 13:32:43",
      "finish_time": "2020-03-12 17:32:43",
      "temp_key": "91234567",
      "qr_code_url": "https://test.akubela.com/w.png",
      "count": 100
    }
  ]
}

失败返回示例

见接口失败返回

创建Akuvox临时密码开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID
start_time	String	Body	是	开始时间，UTC
finish_time	String	Body	是	结束时间，UTC
count	Integer	Body	是	使用次数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
temp_key	String	Body	临时密码
qr_code_url	String	Body	二维码地址

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_akuvox_open_door_temp_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "start_time": "2020-03-12 13:32:43",
    "finish_time": "2020-03-12 17:32:43",
    "count": 100,
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "temp_key": "91234567",
    "qr_code_url": "https://test.akubela.com/w.png"
  }
}

失败返回示例

见接口失败返回

删除Akuvox临时密码开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
temp_key	String	Body	是	临时密码
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_akuvox_open_door_temp_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "temp_key": "88776688",
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

批量删除Akuvox临时密码开门配置

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
temp_key	[]String	Body	是	临时密码
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_akuvox_open_door_temp_key_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "temp_key": [
      "88776688"
    ],
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取Akuvox人脸文件信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
is_uploaded	Boolean	Body	判断人脸文件是否已上传 true：已上传 false：未上传

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_face_file_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "is_uploaded": true
  }
}

失败返回示例

见接口失败返回

更新Akuvox人脸文件信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
filename	String	Body	是	文件名
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_akuvox_face_file_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "filename": "my.jpg",
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

删除Akuvox人脸文件信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_akuvox_face_file_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

校验Akuvox设备权限

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
devices	[]Object<device>	Body	是	设备信息
residence_id	String	Body	是	住宅ID

device说明

参数名	类型	位置	必填	说明
mac	String	Body	是	MAC地址

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
permission	Boolean	Body	判断设备是否有权限 true：有权限 false：无权限
mac	String	Body	MAC地址

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "check_akuvox_device_permission",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "devices": [
      {
        "mac": "0C11050BC115"
      }
    ],
    "residence_id": "r4b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "permission": true,
      "mac": "0C11050BC115"
    }
  ]
}

失败返回示例

见接口失败返回

获取Akuvox通话历史记录

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
call_name	String	Body	通话方名称
call_sip	String	Body	通话方SIP号
call_time	String	Body	通话时间

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_call_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "call_name": "IT83_alq_180",
      "call_sip": "6200105433",
      "call_time": "2020-03-12 17:32:43"
    }
  ]
}

失败返回示例

见接口失败返回

获取Akuvox开门历史记录

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
open_door	Boolean	Body	判断开门是否成功 true：成功 false：失败
account_name	String	Body	账号名称
device_name	String	Body	设备名称
capture_thumbnail_url	String	Body	抓拍缩略图地址
open_door_type	String	Body	开门类型
capture_picture_url	String	Body	抓拍图地址
open_door_time	String	Body	开门时间

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_akuvox_open_door_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

状态码：200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "open_door": true,
      "account_name": "tom",
      "device_name": "R29",
      "capture_thumbnail_url": "https://test.akubela.com/r.jpg",
      "open_door_type": "",
      "capture_picture_url": "https://test.akubela.com/d.jpg",
      "open_door_time": "2020-05-18 15:25:45"
    }
  ]
}

失败返回示例

见接口失败返回

触发Akuvox远程开门

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID
mac	String	Body	是	MAC地址
relay_id	String	Body	是	门控ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "trigger_akuvox_remote_open_door",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "mac": "0C110508EF2E",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "relay_id": "rr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取Akuvox设备列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

relay说明​

请求示例​

成功返回示例​

失败返回示例​

获取Akuvox私钥开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

更新Akuvox私钥开门配置​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

获取Akuvox NFC开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

更新Akuvox NFC开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取Akuvox蓝牙开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

更新Akuvox蓝牙开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取Akuvox临时密码开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

创建Akuvox临时密码开门配置​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

获取Akuvox设备列表

接口地址

请求参数

param说明

返回参数

result说明

relay说明

请求示例

成功返回示例

失败返回示例

获取Akuvox私钥开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

更新Akuvox私钥开门配置

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

获取Akuvox NFC开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

更新Akuvox NFC开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取Akuvox蓝牙开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

更新Akuvox蓝牙开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取Akuvox临时密码开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

创建Akuvox临时密码开门配置

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例